The Arsenal Files 8

home *** CD-ROM | disk | FTP | other *** search

/ The Arsenal Files 8 / The Arsenal Files Collection #8 (Arsenal Computer) (1996).ISO / business / vend31sw.zip / COMPILE.DOC < prev next >

Wrap

Text File | 1996-08-21 | 32KB | 677 lines

PROGRAM TITLE: The Disk Vendor DESCRIPTION: The Disk Vendor is a tool for creating "on-disk" product catalogs. For businesses who would like an alternative to a printed catalog, The Disk Vendor will make the process of creating an on-disk catalog a simple one. The Disk Vendor run-time module is completely menu driven, with a clean simple user interface, which makes it easy for your customers to navigate through and order from. The product catalogs that you create can be distributed on a diskette, or printed to hardcopy format. AUTHOR: Philip P. Kapusta 406 Monroe Avenue Falmouth, VA 22405 USA BBS 540 372-9680 (SYSOP) N-8-1 ANSI 74170.3550@compuserve.com REQUIREMENTS: Hard disk drive, printer, and an editor/word processor. TERMS AND DEFINITIONS: There are several terms that will be used throughout this documentation and that need to be fully understood by the user before you create your own on-disk catalog. Please review these definitions carefully: ASCII FILE: This is a term used to describe any file that you create and save with an editor such as DOS' EDIT or Window's Notepad. The Disk Vendor does NOT come with an editor because most users already have a favorite editor or word processor that they feel comfortable with. We saw no reason to force the user to use another editor and have consequently not included one. An ASCII file contains only characters that can be found on a standard IBM keyboard. CATALOG FILE: A catalog file is an ASCII file that contains product numbers, product names and descriptions. These files are identified by the file extension ".CAT" and can be edited or created with a program like DOS' EDIT editor, or Window's Notepad, or any programmer's editor. You can even use your favorite word processor to edit and generate catalog files, but you must remember to save them as ASCII files. You use The Disk Vendor compiler (COMPILE.EXE) to merge and compress all your individual .CAT catalog files into one single data file (CATALOG.DAT). COMPILER: The compiler is the program that gathers all of your ASCII catalog files (*.CAT) and all other miscellaneous ASCII text files (*.TXT), and then merges and compresses this information into a single data file (CATALOG.DAT). The Disk Vendor compiler also prompts the user for information such as quantity discount rates, your mailing address, sales tax, and currency format before actual compilation begins. DATA FILE: The data file is a specially formatted and compressed file that contains ALL your program titles, prices, mailing address, shipping costs, opening and closing screens, etc. This data file is created by using The Disk Vendor compiler (COMPILE.EXE) and once it has been created it can be identified by the filename "CATALOG.DAT". This data file is one of the two necessary files that must be placed on your distribution disk for your customers. HELLO AND GOODBYE FILES: These are silly sounding terms, I admit, but their names imply what you would think. These are two OPTIONAL files that are displayed at the beginning and end of your on-disk catalog. The opening screen file is identified with the filename "HELLO.TXT" and the closing screen as "GOODBYE.TXT". You can have a hello file without a goodbye file, or vice versa. One does not require the other. Or you may wish to eliminate both. The choice is up to you. These files are extended ASCII files, which means you can use any of the high ASCII characters (graphics) such as ║ ▒ █ ╚ ½ å. (Note: Some printers will not display these characters properly if you are printing the VENDOR.DOC file). RUN-TIME MODULE: Refers to the file "CATALOG.EXE". This is the program that reads the information in your data file and displays it to your customers. Remember, in order to create a catalog on a disk for your customers, two files must exist on that disk: 1) CATALOG.EXE and 2) CATALOG.DAT. SHIPPING FILE: This is a small ASCII file that contains information on the various modes of shipping and costs available to your customer. It is identified by the filename "SHIPPING.TXT". TEXT FILE: Text files are ASCII files that contain miscellaneous messages and notes that you want your customers to have access to. Text files are identified by the file extension ".TXT" and must NOT be confused with catalog files. Text files should NOT contain program titles or descriptions. The contents of text files can only be viewed on the screen, and NO order prompts, prices or discount windows appear in conjunction with "*.TXT" text files. An example of a useful text file would be a file that gives a brief sketch about your company or about how you scan all programs for computer viruses. WAIT FILE: This is a special ASCII file that is displayed to your customers by the run time module as it reads in information from the data file. It can be considered as a commercial message if you wish. It is called a "wait file" because its contents are displayed on the screen as your customer waits for the program to finish a task. It is appropriately identified by the filename "WAIT.TXT". With these terms now under your belt you will be ready to begin creating your own on-disk shareware catalog. LET'S GET STARTED: The first thing that we recommend a brand new user to do is to run the compiler (COMPILE.EXE) and generate a personalized data file (CATALOG.DAT). Then after this execute the run time module (CATALOG.EXE) so that you can see how quick and easy it is to generate a catalog. Do this right now! At the DOS prompt, just enter COMPILE and fill in the blanks as you are prompted by the program. Once you have done this, enter CATALOG at the DOS prompt and look at your results. Before you generate your own catalog files (*.CAT) spend some time getting familiar with the run-time module (CATALOG.EXE). Explore its features and interface. Try placing a few orders as if you were a customer. Print out your order forms, print the catalog, search for words, save and retrieve your orders, etc. By playing with the run- time module you will get a feel for the power and ease of use that The Disk Vendor provides you. Once you have spent some time with the run-time module (CATALOG.EXE) and the compiler (COMPILE.EXE) then you should begin creating your very own catalog files (*.CAT). To begin, use your favorite text editor or word processor and open a new file. We will call the name of the new file "VIRUS.CAT" and we will generate a catalog file that contains virus checking software programs. Note: You can give the file any name you wish as long as it contains the file extension ".CAT". "SOFTWARE.CAT", "DISNFECT.CAT", "_VIRUS_.CAT" are all valid catalog file names. Whatever is easiest for you to remember, give it an appropriate filename. THE STRUCTURE OF A CATALOG FILE: Once you begin a new catalog file, there is a specific format that you must follow: 1) The very first line of the catalog file (*.CAT) must contain a 34 character or less description. The first line of a catalog file will be used in the Main Menu catalog index listing. 2) A pound symbol "#" separates one program title and its description from another. The "#" can be followed by your catalog number identifying the program that follows it. Catalog order numbers must not be longer than 20 characters. 3) The title of the shareware program follows on the next line after the line that contains the "#" symbol. 4) Any lines after the title line are used for you to describe that particular title. These lines are called "program description" lines. 5) Product description line length must not exceed 72 characters in width. This is one rule that is often easily forgotten. It may seem minor, but for the program to generate a printed catalog for your customers with a sufficient left margin for punching holes for a 3-ring binder, product description lines can not exceed nor encroach upon the margins. Most "good" text editors will have the option to define a right margin width, and with a word-wrap feature, this 72 character line limit will not pose a problem. Most word processors that export ASCII text also will word wrap, along with being able to define a right margin. The compiler will catch any violations and will stop, bringing to your attention any line length violations. I have a favorite text editor called Multi-Edit, published by American Cybernetics. For approximately $80 it is loaded with everything you could want in a text editor. I highly recommend it if you can afford it and are looking for a text editor besides the freebie Microsoft ships with DOS versions 5.0 and up. All right, got it? Clear as mud? Probably. So here are some examples that will help you. Again, we are in our editor and have the file "VIRUS.CAT" open. With the cursor at the very top of the document (line 1), enter a description used to identify the contents of the catalog file: ┌─────────────────────────────────────────────────────────┐ │Virus protection │ │ │ │ │ │ │ It is simple so far, isn't it? Just keep the number of characters in this category description line less than 34. Now, on to line 2! As we stated above, a "#" symbol separates one program from another. Since we are about to enter a new program title and description, we need to place a "#" on line 2, column 1: ┌─────────────────────────────────────────────────────────┐ │Virus protection │ │# │ │ │ │ │ If you wish to identify your shareware offerings using a catalog number, now is the time to do so. Immediately following the "#" symbol, enter your catalog number. The number does not need to be a number, but can be characters if you so choose, or a combination of both. For example: ┌─────────────────────────────────────────────────────────┐ │Virus protection │ │#VI040 │ │ │ │ │ Again, you are not required to enter a catalog number if you choose not to. What is mandatory, however, is that a "#" symbol exists in column 1 above a program title line. When you are ready to enter a program title, move down one line below the "#" and enter it: ┌─────────────────────────────────────────────────────────┐ │Virus protection │ │#VI040 │ │Expel │ │ │ In the example above the shareware program "Expel" has been placed immediately below the line containing the "#" symbol. To show you some of the features unique to The Disk Vendor we will let you know here that you can add a comment note on the same line as the program title. A comment note may consist of anything you wish, as long as it is enclosed in squiggly brackets {}. For example, let's say that Expel was stored on my hard disk drive in compressed PKZIP format. In order to locate it better, you can add a comment note recording its location and archive name. For example: ┌─────────────────────────────────────────────────────────┐ │Virus protection │ │#VI040 │ │Expel {C:\SHARE\EXPEL30.ZIP} │ │ │ Above we see that the program Expel exists on your hard disk in a subdirectory C:\SHARE and is named EXPEL30.ZIP. This comment note is enclosed in {} brackets. The brackets are very important! When this catalog file is compiled, your comment notes are ignored. Comment notes in {} brackets do not appear to your customer because they never find their way into the data file (CATALOG.DAT). Comment notes are for your use and are optional. You can enter anything you wish between {} brackets - the name of the author, the date your obtained the program, whether the program is a piece of junk, the location of the file (such as the name of a CD-ROM), or whatever. Again, this comment note is optional. Another feature which you should be aware of at this point are "disk set markers". What do you do if a particular shareware title is a 3 disk set, and must be sold as a set? How do you indicate to the customer that they are about to order 3 disks, and that the price calculated for this title should be tripled? The solution is to place "disk set markers" on the program title line. A disk set marker is the asterisk symbol "*". For instance, if Expel is sold as a 3 disk set, place 3 asterisk symbols following the program title and on the same line. ┌─────────────────────────────────────────────────────────┐ │Virus protection │ │#VI040 │ │Expel {C:\SHARE\EXPEL30.ZIP} *** │ │ │ You can place the disk set markers before or after a comment note if you wish - it makes no difference. Just make sure a space exists between each field. At least one space must exist between any program title, comment note, and disk set marker. So in review, use "***" to indicate a 3 disk set, "*****" to indicate a 5 disk set, and "**********" to indicate a 10 disk set. If the program title is distributed on just one disk, then do absolutely nothing! Only use the "*" character to indicate MULTIPLE DISK SETS! A single "*" is invalid and serves no purpose whatsoever. Now that we have entered a disk number, and a program title, all we have left is to give Expel a description. The description lines follow immediately below the program title line. For example, let's describe what Expel is: ┌─────────────────────────────────────────────────────────┐ │Virus protection │ │#VI040 │ │Expel {C:\SHARE\EXPEL30.ZIP} *** │ │Anti-virus program that helps preserve the integrity of │ │your files. │ │ │ You could get more descriptive if you wish. Keep all description lines less than 72 characters wide. You can insert blank lines if you wish, and they will be preserved when compiled. Believe it or not, that is all there is to it! Not very hard is it? To add additional programs to our "VIRUS.CAT" catalog file, simply repeat steps 2-4 above. Here is our catalog file after adding two more virus checking programs: ┌─────────────────────────────────────────────────────────┐ │Virus protection │ │#VI040 │ │Expel {C:\SHARE\EXPEL30.ZIP} *** │ │Anti-virus program that helps preserve the integrity of │ │your files. │ │#VI107 │ │ │Flu Shot+ │ │Protects you system against virus and Trojan horse │ │programs. Read/write protection for programs. Checks for │ │contamination and prevents virus activities. │ │#VI100 │ │Scan/Clean {Version 9.2.1} │ │SCAN checks an entire disk for over 100 different virus │ │strains. CLEAN will remove any existing viruses. │ │ │ Notice that you do NOT repeat the "Virus protection" file description line. This occurs only ONCE, and must be on the first line of your catalog file (VIRUS.CAT). We strongly recommend that you enter/insert new programs in alphabetical order. This will make your catalog easier to navigate through when viewed by your customers. There exists a function in The Disk Vendor run-time module (CATALOG.EXE) that lists all the program titles in the currently selected category. This listing displays the program titles in the same order in which you entered them into the catalog file. Therefore, if you want this list to appear in alphabetical order, you should enter the programs in alphabetical order. The Disk Vendor will not sort this list because it wants you to practice good catalog file creation and maintenance. It is to your benefit also to enter and maintain programs in alphabetical order. It not only makes it easier for your customers to locate programs, but it makes it easier for you to locate programs when it comes time to update or purge programs from an existing catalog file. If these 3 titles are all you have in the way of virus checking shareware titles, then close the "VIRUS.CAT" catalog file and save it to disk. One last feature that you may be interested in adding to your catalog file is a "customer note". A "customer note" contains text information that helps better describe the items that follow. A "customer note" does NOT have prices or part numbers attached to them. You begin a customer note with a "#" symbol, immediately followed by "NOTE#". Move down one line and enter a header line, then move down one line and enter the ASCII text that makes up your note. Using the VIRUS.CAT file as an example: ┌─────────────────────────────────────────────────────────┐ │Virus protection │ │#VI040 │ │Expel {C:\SHARE\EXPEL30.ZIP} *** │ │Anti-virus program that helps preserve the integrity of │ │your files. │ │#NOTE# │ │WHAT IS A COMPUTER VIRUS? │ │A computer virus is a program designed to replicate and │ │spread on its own, preferable without you knowing it │ │exists. Like a human body, computers are vulnerable to │ It is best to experience a customer note in a compiled data file first hand in order to appreciate its usefulness. We have included a lengthy note on computer viruses in the VIRUS.CAT file that accompanied this program. Take a good look at this file to understand how it works. Customer notes can occur anywhere in your catalog files, and they can be unlimited in length (1 to 1000 lines) but are restricted to 72 columns in width. A few other guidelines that you should be aware of when working with catalog files (*.CAT): Use lower case letters as much as possible. Upper case letters do not compress well during compile time. On average you will achieve a 40% file size reduction if the majority of your catalog files are in lower case (before: 100,000K, after: 60,000K). Don't overdo this, of course. Just type your catalog files as if you were typing a letter to a friend. Keep the CAPS LOCK off, and avoid entering program titles in uppercase and you will be OK (or is it "ok"?). Do not use high ASCII characters in your catalog files (*.CAT). Characters such as ║ ▒ █ ╚ ½ å will not be compiled properly. Absolutely avoid them! OTHER NECESSARY FILES BEFORE COMPILING: Although your catalog files (*.CAT) are the most important files that you need to have prior to compilation, there are additional files that you can and should create. The first mandatory file required for compilation is a "wait file". This file is an ASCII text file that contains a message for your customer while the run-time module works on a task. This file can be created with an editor, and must be saved with the filename "WAIT.TXT". If this file does not exist when you go to compile your catalog using COMPILE.EXE the compilation process will abort. "WAIT.TXT" is absolutely mandatory. With The Disk Vendor package that you have received a sample "WAIT.TXT" file can be found that you may use as a guide. The most important things that you must remember when working with the "WAIT.TXT" file is that it can NOT be longer 72 characters wide by 17 rows high. Also, this wait file must not contain any high ASCII characters. The second (and last) mandatory file that must exist prior to compilation is a shipping text file. Identified with the filename "SHIPPING.TXT", this file contains information on the shipping/mailing methods that you provide your customers with, and their costs. A sample "SHIPPING.TXT" file has been included with The Disk Vendor system that you received and can be used as a guide. Its format is as follows: [Type of shipping]=[Cost] Where [Type of shipping] is replaced with the words identifying the type of shipping/mailing method available, and where [Cost] is replaced with the actual cost. These two parameters are linked together with a "=" equals symbol. Here is a real life example of a "SHIPPING.TXT" file, so that you can see better the format you must follow: USPS (US)=2.95 USPS (Canada)=5.00 USPS (Elsewhere)=7.00 UPS Ground (US)=4.00 UPS Blue (48 Sts)=7.00 UPS Blue (AL HI PR)=8.00 UPS Red (US)=16.00 UPS Red (AL HI PR)=19.00 Federal Express overnight=20.00 You can have one line in your shipping file, or 10 lines. You have the choice to add or delete any lines. The only requirement is that at least one line exists in the "SHIPPING.TXT" file, and that you follow the format outlined above. Having your catalog files (*.CAT) and the "WAIT.TXT" and "SHIPPING.TXT" files, you can now begin the compilation process if you wish. These files are mandatory before running COMPILE.EXE. You may wish to add some additional files, but this is optional (see next section). OPTIONAL TEXT FILES TO INCLUDE IN YOUR CATALOG: Many shareware distributors may wish to add additional ASCII text files for their customers to view. This can be done with an editor, and the only requirements that The Disk Vendor impose are: 1) The text file must NOT contain control characters nor high ASCII characters > 126 (decimal). 2) The text file must be saved with a filename extension ".TXT" (short for "text"). "BONUS.TXT", "README.TXT", "COUPON.TXT", "SPECIALS.TXT" are all valid text filenames. 3) The text file can be any length in number of rows (within reason), but must not exceed 72 characters/columns in width. 4) The first line of your .TXT file must be reserved for a description line. This reserved description line works exactly as the description line in your catalog files (*.CAT). This description line will appear in the Main Menu catalog index box and must contain less than 35 characters. Again, this description line MUST reside on line 1 of your text file! What would you use .TXT files for? Some possibilities are: To describe your company and its products. To display a discount coupon that the customer can print using the PRINT SCREEN key and then redeem. To describe what the Association of Shareware Professionals is. To assure your customers that all your products have been scanned for viruses. HELLO AND GOODBYE: Should you wish to create a special opening screen that your customer views before the Main Menu screen appears, then create a "hello" file. This file is also created using an editor, and must be saved with the filename "HELLO.TXT". Unlike other ASCII text files, the "HELLO.TXT" file can contain high ASCII graphic characters. This will enable you to create some attractive opening screens with boxes and shadows and text. The "HELLO.TXT" file can contain up to 25 lines of characters by 80 characters in width (the size of a normal text mode screen). Here is an example of what you could do: ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓┌───────────────────────────────────────┐▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓│ │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ XYZ COMPUTERS PROUDLY PRESENTS │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ ITS WINTER 1995 SHAREWARE │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ CATALOG ON A DISK │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ Press any key to begin... │░░▓▓▓▓▓▓▓ ▓▓▓▓▓│ │░░▓▓▓▓▓▓▓ ▓▓▓▓▓└───────────────────────────────────────┘░░▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ Just remember to include an instruction for your customer to "PRESS ANY KEY TO CONTINUE..." or else you may find your customer scratching his head wondering what to do next. You may never receive an order from him because he could not get past your opening screen! Likewise, if you wish to have a special message appear at the close of the program, create a "goodbye" file with an editor. Follow exactly the same guidelines as described above for the "hello" file, but save this file as "GOODBYE.TXT". Again, remind the customer with a message to press any key to exit the program! Both the "HELLO.TXT" and "GOODBYE.TXT" files are optional. You may wish not to have opening or closing screens, or you may wish to have one but not the other. This is fine. Just delete the files you don't need, or don't create them in the first place. For those who wish to use a high-resolution VGA graphic image in the place of the text based HELLO.TXT and GOODBYE.TXT files, contact the author for details on how to incorporate .PCX images at the beginning and/or close of your catalog. THAT'S ALL THERE IS TO IT!: Speaking of "goodbyes", the instructions above are all you need to get you up and running creating your own personal shareware catalog on disk. We hope that you find The Disk Vendor a useful tool in marketing your shareware products. SHAREWARE AND SOAPBOXES: The Disk Vendor is shareware software and continued use of the program requires you to support the author. Once you have registered, you will receive the latest version of The Disk Vendor that will permit you to begin distributing your compiled data file (CATALOG.DAT) and the run-time module (CATALOG.EXE) freely without royalties. Although we feel confident that you will not find a better and more flexible product for marketing your shareware, there is one group of distributors that would do well to not use The Disk Vendor. To get specific, The Disk Vendor must not be used by vendors who distribute so-called "Adult" (R/X-rated) software. We will not be a party in helping such vendors distribute this type of software. The distribution of "Adult" software has gotten out of hand, and a glance at the back classified pages of any Computer Shopper magazine serves as an example. We will not go any further but to repeat that such vendors are not permitted to use The Disk Vendor to distribute their products. ALL IN THE FAMILY: For those interested, we have another version of The Disk Vendor that is directed towards the non-shareware world. We refer to it as the "general business version" of The Disk Vendor. This close cousin looks and works almost identically to the version that you now have, but it is directed towards the general business market where ANY TYPE OF PRODUCT can be sold through it. In other words, this close cousin allows a business to sell anything from anchors to zucchini. Instead of the menu prompt for 360K/720K... one will discover a menu prompt for quantity (1,2,3,...) and allows each item in the catalog to have a SEPARATE AND DIFFERENT PRICE. If this is something you may be interested in, contact the author with a self-addressed stamped envelope for details or call our BBS (540) 372-9680 for an evaluation copy. CD-ROM LIBRARIES: Some vendors have recently begun using shareware CD-ROMs as their SOLE library for programs that they distribute. If you would like to have a ALLFILES.BBS or FILES.BBS or any other CD-ROM master file converted into a format that The Disk Vendor can read, contact the author. We have written several utilities that perform such functions that will save you hours of work. If you are interested in purchasing one of these utilities, please call our BBS and upload a copy of the ALLFILES.BBS file, attention to the SYSOP. We ask this because each CD-ROM is different, and to insure the correct utility, we need to see the file(s) in question. The conversion utility is $20.00, and should your CD-ROMs be different from each other (Nightowl vs. Pier, etc.), then each additional utility is only $15.00. yy